Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds typescript typings. This will allow typescript users to use random-words with no extra effort.
What are the specific steps to test this change?
yarn add 'git+https://github.com/stretchkennedy/random-words.git#upstream-ts-declarations'
random-words
What kind of change does this PR introduce?
(Check at least one)
Make sure the PR fulfills these requirements:
Related documentation has been updatedRelated tests have been updatedOther information:
Adapted from work I did in my nodejs fork. I'm putting it here in case it's useful to anyone else. See #7 for prior work, though this PR uses a separate function declaration for options that set
join
to avoid a return type ofstring | string[]
.I don't think it needs documentation and I don't think tests would be useful for typescript typings (but I'm happy to write both if a maintainer can point me in the right direction).